/**
 * Software License, Version 1.0
 * 
 * Copyright 2003 The Trustees of Indiana University.  All rights reserved.
 * 
 *
 *Redistribution and use in source and binary forms, with or without 
 *modification, are permitted provided that the following conditions are met:
 *
 *1) All redistributions of source code must retain the above copyright notice,
 * the list of authors in the original source code, this list of conditions and
 * the disclaimer listed in this license;
 *2) All redistributions in binary form must reproduce the above copyright 
 * notice, this list of conditions and the disclaimer listed in this license in
 * the documentation and/or other materials provided with the distribution;
 *3) Any documentation included with all redistributions must include the 
 * following acknowledgement:
 *
 *"This product includes software developed by the Community Grids Lab. For 
 * further information contact the Community Grids Lab at 
 * http://communitygrids.iu.edu/."
 *
 * Alternatively, this acknowledgement may appear in the software itself, and 
 * wherever such third-party acknowledgments normally appear.
 * 
 *4) The name Indiana University or Community Grids Lab or NaradaBrokering, 
 * shall not be used to endorse or promote products derived from this software 
 * without prior written permission from Indiana University.  For written 
 * permission, please contact the Advanced Research and Technology Institute 
 * ("ARTI") at 351 West 10th Street, Indianapolis, Indiana 46202.
 *5) Products derived from this software may not be called NaradaBrokering, 
 * nor may Indiana University or Community Grids Lab or NaradaBrokering appear
 * in their name, without prior written permission of ARTI.
 * 
 *
 * Indiana University provides no reassurances that the source code provided 
 * does not infringe the patent or any other intellectual property rights of 
 * any other entity.  Indiana University disclaims any liability to any 
 * recipient for claims brought by any other entity based on infringement of 
 * intellectual property rights or otherwise.  
 *
 *LICENSEE UNDERSTANDS THAT SOFTWARE IS PROVIDED "AS IS" FOR WHICH NO 
 *WARRANTIES AS TO CAPABILITIES OR ACCURACY ARE MADE. INDIANA UNIVERSITY GIVES
 *NO WARRANTIES AND MAKES NO REPRESENTATION THAT SOFTWARE IS FREE OF 
 *INFRINGEMENT OF THIRD PARTY PATENT, COPYRIGHT, OR OTHER PROPRIETARY RIGHTS. 
 *INDIANA UNIVERSITY MAKES NO WARRANTIES THAT SOFTWARE IS FREE FROM "BUGS", 
 *"VIRUSES", "TROJAN HORSES", "TRAP DOORS", "WORMS", OR OTHER HARMFUL CODE.  
 *LICENSEE ASSUMES THE ENTIRE RISK AS TO THE PERFORMANCE OF SOFTWARE AND/OR 
 *ASSOCIATED MATERIALS, AND TO THE PERFORMANCE AND VALIDITY OF INFORMATION 
 *GENERATED USING SOFTWARE.
 */
package cgl.narada.wsinfra.deployment.impl;

import java.util.Enumeration;

import javax.xml.soap.SOAPMessage;

import cgl.narada.wsinfra.deployment.FilterPipeline;
import cgl.narada.wsinfra.deployment.RoleExecutionEnvironment;
import cgl.narada.wsinfra.deployment.SOAPContext;
import cgl.narada.wsinfra.deployment.SOAPContextFactory;
import cgl.narada.wsinfra.exception.DeploymentException;

/** The role execution environment is responsible for ensuring that 
    processing related to the execution of roles is performed. In some cases
    it is possible that this class is responsible for ensuring completion of 
    processing for multiple roles. 

    @author Shrideep Pallickara
    $Date: 2005/07/29 22:44:01 $
    $Revision: 1.1 $
*/


public class RoleExecutionEnvironmentImpl extends RoleExecutionEnvironment{
  
  private static final RoleExecutionEnvironment instance = 
  new RoleExecutionEnvironmentImpl();
  
  private RoleManagerImpl roleManager;
  private SOAPContextFactory soapContextFactory;
  private String moduleName = "RoleExecutionEnvironmentImpl: ";


  private RoleExecutionEnvironmentImpl() {
    soapContextFactory = SOAPContextFactory.getInstance();
  }

  public static RoleExecutionEnvironment getInstance() {
    return instance;
  }
  

  /** Manages the execution of a role for a SOAP message received over the 
      network. */
  public void manageExecutionOfRole(String role, SOAPMessage soapMessage) 
    throws DeploymentException { 
    checkSoapMessageForProblems(soapMessage);
    SOAPContext soapContext = soapContextFactory.newSOAPContext(soapMessage);
    manageExecutionOfRole(role, soapContext);    
  }


  
  /** Manages the execution of a set of roles for a SOAP message received over
      the  network. */
  public void manageExecutionOfRoles(Enumeration roles, 
				     SOAPMessage soapMessage) 
    throws DeploymentException {
    checkSoapMessageForProblems(soapMessage);
    SOAPContext soapContext = soapContextFactory.newSOAPContext(soapMessage);
    while (roles.hasMoreElements()) { 
      String role = (String) roles.nextElement();
      manageExecutionOfRole(role, soapContext);
    }
  }

  

  /** Manage the execution of a role. */
  private void manageExecutionOfRole(String role, SOAPContext soapContext) 
    throws DeploymentException {
    System.out.println(moduleName + "Managing execution of role [" +role +"]");
    checkIfRoleIsNull(role);
    
    initializeRoleManager();
    if (!roleManager.hasSupportForRole(role)) {
      String report = moduleName + "Role (" + role + ") has NOT been " + 
	"registered with the RoleManager so no processing performed for role.";
      System.out.println(report);
      return;
    }

    FilterPipeline filterPipeline = getFilterPipelineForRole(role);
    filterPipeline.executeInputFilters(soapContext);
  }




  /** Retrieves the filter pipeline for a role */
  private FilterPipeline getFilterPipelineForRole(String role) 
    throws DeploymentException {
    checkIfRoleIsNull(role);
    
    FilterPipeline filterPipeline = roleManager.getFilterPipelineForRole(role);
    return filterPipeline;
  }



  /** Checks to see if the role is NULL. */
  private void checkIfRoleIsNull(String role) throws DeploymentException {
    if (role == null) {
      throw new DeploymentException(moduleName + 
				    "The specified role is NULL!");
    }    
  }


  /** Initializes the role manager. */
  private void initializeRoleManager() {
    if (roleManager == null) {
      roleManager = (RoleManagerImpl) RoleManagerImpl.getInstance();
    }
  }


  /** Check SOAPMessage for problems. */
  private void checkSoapMessageForProblems(SOAPMessage soapMessage) 
    throws DeploymentException { 
    if (soapMessage == null) {
      String errorReport = moduleName + "Received SOAP message is NULL." + 
	" No further processing is possible.";
      throw new DeploymentException(moduleName);
    }
  }

}
